Get schedule execution's Tasks

{ getTasks }

Returns the list of tasks for a Schedule Execution

Method

/API3/tasks/getTasks

  • API Section: /API3/tasks
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Input Parameters

    Name

    executionsId

    Type

    string

    Description

    The execution's system ID

    Output Response

    Successful Result Code

    200

    Response List Type

    TaskViewData[]

    Description of Response Type

    Execution Tasks object with details of a scheduled job task.. Note that the response is returned as a list of items of this object type.

    Notes

    Each schedule produces an 'execution' each time it runs. The execution is effectively an instance of the schedule. Within each execution is a list of jobs or 'tasks' tha represent the atomic level of activity that will be executed.The task list can be sued to see status of each task or to rerun a specific job using 'reRunTask'

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/tasks/getTasks" \
 -d ''

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.TasksServiceApi;

import java.util.*;
import java.time.*;

public class TasksServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TasksServiceApi apiInstance = new TasksServiceApi();
        // Initialize the executionsId parameter object for the call
        String executionsId = executionsId_example; // Create the input object for the operation, type: String 

        try {
            // "array[TaskViewData]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[TaskViewData] result = apiInstance.getTasks(executionsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksServiceApi#getTasks");
            e.printStackTrace();
        }
    }
}

    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.TasksServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const executionsId = executionsId_example; // {String} 

api.getTasks(executionsId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getTasksExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new TasksServiceApi();
        // Initialize the executionsId parameter object for the call
        var executionsId = executionsId_example;  // Create the input object for the operation, type: String | 

        try {
            // Returns the list of tasks for a Schedule Execution
            // "array[TaskViewData]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[TaskViewData] result = apiInstance.getTasks(executionsId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling TasksServiceApi.getTasks: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import TasksServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = TasksServiceApi(api_client)
    # Initialize the executionsId parameter object for the call
    executionsId = executionsId_example # String | 

    try:
        # Returns the list of tasks for a Schedule Execution
        api_response = api_instance.get_tasks(executionsId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TasksServiceApi->getTasks: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TasksServiceApi();
$executionsId = executionsId_example; // String | 

try {
    $result = $api_instance->getTasks($executionsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksServiceApi->getTasks: ', $e->getMessage(), PHP_EOL;
}
?>